/*
 * Copyright 2012 Faculty of Informatics - Masaryk University.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package cz.muni.fi.pa165.creatures.dao;

import cz.muni.fi.pa165.creatures.model.Region;
import java.util.List;

/**
 * This interface represents a contract for implementation of the DAO for the
 * {@link cz.muni.fi.pa165.creatures.model.Region} entity.
 *
 * @author hulek
 */
public interface RegionDAO {

    /**
     * This method creates a region.
     *
     * @param region region to create
     * @return id of the created region
     */
    Long create(Region region);

    /**
     * This method removes a region.
     *
     * @param region region to remove
     */
    void remove(Region region);

    /**
     * This method updates already existing region.
     *
     * @param region region to update
     */
    void update(Region region);

    /**
     * This method gets a region of some {@code id}.
     *
     * @param id id of the region we want to get
     * @return region of specified {@code id}, null otherwise
     */
    Region get(Long id);

    /**
     * This method returns count of regions in our simple world.
     *
     * @return number of the all regions
     */
    Long getCount();

    /**
     * This method returns all regions in our simple world.
     *
     * @return a list of all regions
     */
    List<Region> getAll();

    /**
     * Deletes all regions.
     */
    void deleteAll();

    /**
     * Gets a region by name.
     * @param name name of a region to get
     * @return region of specified name
     */
    Region getByName(String name);
}
